home *** CD-ROM | disk | FTP | other *** search
/ Acorn User: The Risc OS Music Utilities CD / Acorn User: The Risc OS Music Utilities CD.iso / ARGONET / REPLAYER.SPK / ReadMe < prev    next >
Text File  |  1998-09-07  |  5KB  |  133 lines
  1.  
  2.                          Replayer version 1.0.0       (5th September 1998)
  3.                         ========================
  4.  
  5. 0. Contents
  6. -----------
  7.   1. Introduction
  8.   2. Using the libraries
  9.   3. Using the command-line programs
  10.   4. Compiling it, and linking against it
  11.   5. Version history
  12.   6. Things to do
  13.   7. Author and copyright
  14.  
  15.  
  16. 1. Introduction
  17. ---------------
  18. Replayer is a library which actually consists of two separate libraries. 
  19. The first (`replaydriver.h') deals with using the Acorn Replay sound drivers
  20. to play raw sound data.  The second (`replayer.h') will play the sound
  21. portion of Acorn Replay files, using the first library.
  22.  
  23. Two example command-line programs are provided.  playraw plays raw sound
  24. data using `replaydriver.h'.  replayer plays Replay files using
  25. `replayer.h', with a few nice features such as a simple playlist,
  26. interactive control, and file diagnostics.
  27.  
  28. Parts of Replayer are also fairly portable (such as the ARMovie file header
  29. reader), so it would not require much effort to port the Replay file player
  30. to another platform if you wanted.
  31.  
  32. One special feature is that Replayer can play Replay files backwards!  If
  33. you have a program like CDAudio (which provides a filing system that
  34. presents audio CD tracks as Replay files), you can use it to search for
  35. hidden messages in music!
  36.  
  37. Future versions will be available from:
  38.  
  39.   <http://www.argonet.co.uk/users/mseaborn/comp/programs.html#replayer>
  40.  
  41.  
  42. 2. Using the libraries
  43. ----------------------
  44. There isn't any documentation as such, but reading the header files will
  45. give you an idea of what functions are provided.  More information about
  46. each function is given in the comments in the actual C source files.
  47.  
  48. The examples, replayer and playraw are also helpful.  If you need more
  49. information, e-mail me and I'll try to help.
  50.  
  51.  
  52. 3. Using the command-line programs
  53. ----------------------------------
  54. Do `playraw -h' and `replayer -h' for information on running each
  55. respectively.  That should be all the info you'll need.
  56.  
  57. If you want a desktop front-end, the next version of Harmony will use
  58. Replayer, and will be available from
  59. <http://www.argonet.co.uk/users/mseaborn/harmony/harmony.html>.
  60.  
  61.  
  62. 4. Compiling it, and linking against it
  63. ---------------------------------------
  64. You will need:
  65.  
  66.  * A C compiler.  I used Norcroft C (Acorn's compiler), but gcc could be
  67.    used (I haven't tried it).
  68.  * An ARM assembler.  Acorn's ObjAsm or the free `as'.
  69.  * Linker, C library, etc.
  70.  * OSLib.
  71.  * make and Makatic are useful, but not required.
  72.  * MakeUtils from my Dreamscape library.
  73.  * Probably some things I've forgotten.
  74.  
  75. A compiled version of the library, `Replayer:o.replaylib', is included
  76. (built with Norcroft C, for linking with the Shared C Library stubs). 
  77. Executables for the command-line programs are included.
  78.  
  79. Macros for compiling different builds
  80. - - - - - - - - - - - - - - - - - - -
  81. There are a couple of macros which, when defined, change what variant of
  82. Replayer is build (they are undefined by default):
  83.  
  84. `replayer_NO_ATEXIT_HANDLER':
  85. Stops the replayer component from registering an atexit handler to destroy
  86. all replayer objects on exit.  This makes it more suitable for using in a
  87. relocatable module.  An atexit handler is not needed if you know your
  88. program will not leave any files playing when it quits.
  89.  
  90. `replayer_NO_BACKWARDS':
  91. Removes support for playing sound backwards.  Reduces featuritis, and shaves
  92. a few bytes off the executable size!
  93.  
  94.  
  95. 5. Version history
  96. ------------------
  97. Before 1.0.0 (written around October 1997):
  98.   Not released and not numbered.
  99.  
  100. 1.0.0 (released 5th September 1998):
  101.   After numerous improvements and additions, as well as more testing, this
  102.   is the first release version.
  103.  
  104.  
  105. 6. Things to do
  106. ---------------
  107. Features to add:
  108.  * Jumping to given places within a file.
  109.  * Support for backwards playing with type 2 sound (not worth it).
  110.  * Other extras to complement backwards playing.
  111.  
  112. Bugs:
  113.  * Better tidying up on errors (especially in header.c).
  114.  
  115.  
  116. 7. Author and copyright
  117. -----------------------
  118. Replayer was written by me, where I am Mark Seaborn.  I can be contacted by
  119. e-mail at <mseaborn@argonet.co.uk>.  If, in the far future, this e-mail
  120. address ceases to work, try using <mseaborn@bigfoot.com>.  A Web page for
  121. Replayer can be found at
  122. <http://www.argonet.co.uk/users/mseaborn/comp/programs.html#replayer>.
  123.  
  124. This software is copyright (c) 1997/8 Mark Seaborn.  You can modify and
  125. distribute it under the terms and conditions of the GNU Library General
  126. Public Licence version 2, or, at your option, a later version.  (However, I
  127. am open to negotiation for different licences if you find the LGPL's
  128. conditions too strict.)
  129.  
  130. If you have any suggestions or improvements, or have found (or even fixed) a
  131. bug, please contact me!  I'd particularly like to hear from you if you've
  132. ported Replayer to another platform!
  133.